home *** CD-ROM | disk | FTP | other *** search
/ The Business Master (3rd Edition) / The Business Master (3rd Edition).iso / files / utilstem / anarkey / convert.doc < prev    next >
Text File  |  1989-10-01  |  11KB  |  303 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                                     CONVERT
  10.                         The Anarkey AKA Conversion Utility
  11.                                   User Manual
  12.  
  13.                                   Version 3.00
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                 Steven Calwas
  37.                                Moderne Software
  38.                                 P.O. Box 3638
  39.                           Santa Clara, CA 95055-3638
  40.  
  41.  
  42.                               _______
  43.                          ____|__     |               (tm)
  44.                       --|       |    |-------------------
  45.                         |   ____|__  |  Association of
  46.                         |  |       |_|  Shareware
  47.                         |__|   o   |    Professionals
  48.                       -----|   |   |---------------------
  49.                            |___|___|    MEMBER
  50.  
  51.  
  52.  
  53.  
  54.                               Copyright (C) 1989
  55.                                by Steven Calwas
  56.                               All rights reserved
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.                                 Introduction
  73.                                 ------------
  74.  
  75.    CONVERT will translate alias and synonym definitions of other command-
  76. line editors into an ANARKEY AKA-compatible format.  The resulting file can
  77. then be used as input to LOAD which will pass the list of AKA definitions to
  78. ANARKEY.  Thus, if you have accumulated a list of aliases and synonyms for
  79. another command-line editor, CONVERT can help make the transition to ANARKEY
  80. a smooth and painless experience.
  81.  
  82.    CONVERT can process alias and synonym definitions for the following
  83. command-line editors:
  84.  
  85.                                 -- CED
  86.                                 -- PCED
  87.                                 -- DOSEDIT
  88.  
  89.    Note: Further editing may be required on some of the converted
  90. definitions, especially PCED definitions, before they may be used as input
  91. to LOAD.
  92.  
  93.  
  94.  
  95.                                Getting Started
  96.                                ---------------
  97.  
  98.    CONVERT command-line syntax is:
  99.  
  100.         CONVERT -type input_file [output_file]
  101.  
  102.    The type argument indicates the format of the definitions to be
  103. converted, for example, whether they are CED-compatible synonyms or DOSEDIT
  104. aliases.  The type may be specified anywhere on the command line and must be
  105. immediately preceded by a dash (-) character.  It may be in upper or
  106. lowercase.  The supported type arguments are:
  107.  
  108.                     -C      -- convert CED synonyms
  109.                     -D      -- convert DOSEDIT aliases
  110.                     -P      -- convert PCED synonyms
  111.  
  112.    Input_file specifies the disk file containing the original alias or
  113. synonym definitions.  The file's name may include an optional drive and path
  114. specification.
  115.  
  116.    Output_file specifies the disk file to where the converted AKA-compatible
  117. definitions should be written.  The output_file name may contain an optional
  118. drive and path specification.  Following creation, this file can be used as
  119. input to LOAD.  (Refer to the "LOAD User Manual" for instructions on using
  120. LOAD.)
  121.  
  122.    The output_file argument is optional.  If output_file is not specified,
  123. CONVERT will write the AKA-compatible definitions to the file ANARKEY.AKA in
  124. the current directory of the current drive.
  125.  
  126.    Sample CONVERT command lines are:
  127.  
  128.          CONVERT -c syn.def anarkey.cfg
  129.          CONVERT -d dosedit.ali
  130.          CONVERT -p pced.syn c:\bin\anarkey.syn
  131.  
  132.    In the first example, the CED synonyms (specified by the -C type
  133. argument) contained in the file SYN.DEF will be converted and saved to a
  134. file called ANARKEY.CFG.
  135.  
  136.    The second example translates the DOSEDIT definitions (-D) in DOSEDIT.ALI
  137. and writes the converted aliases to the default output file ANARKEY.AKA.
  138.  
  139.    Finally, the PCED definitions in PCED.SYN are converted and written to
  140. the file C:\BIN\ANARKEY.SYN.
  141.  
  142.  
  143.  
  144.                         Converting DOSEDIT Aliases
  145.                         --------------------------
  146.  
  147.    CONVERT will successfully translate 100% of the definitions contained in
  148. a DOSEDIT alias file.  No further editing will be required on the output
  149. file; it may be fed immediately as input to LOAD.
  150.  
  151.    DOSEDIT users would benefit immensely by becoming familiar with the
  152. additional power available in ANARKEY AKAs.  The capabilities to pass
  153. parameters to AKAs and to create AKAs consisting of multiple commands should
  154. reduce your editing time significantly.  The many other powerful features of
  155. ANARKEY contribute even further to make it an attractive alternative.
  156.  
  157.    Welcome to ANARKEY!
  158.  
  159.  
  160.  
  161.                        Converting CED and PCED Synonyms
  162.                        --------------------------------
  163.  
  164.    CONVERT will perform most of the grunt editing work required to translate
  165. CED and PCED synonyms to an ANARKEY-compatible format.
  166.  
  167.    However, while all synonyms will be translated to a valid ANARKEY format,
  168. the resulting AKA will not always be the exact equivalent to the original
  169. synonym.  This is especially true of converted PCED synonyms.  Some manual
  170. touch-up will be required on these definitions to complete the conversion.
  171. The types of definitions requiring touch-up will be pointed out as this
  172. discussion unfolds.
  173.  
  174.    CONVERT recognizes and processes the following CED/PCED commands:
  175.  
  176.                                 CHAINCH
  177.                                 PARAMCH
  178.                                 SYN
  179.                                 USERSYN
  180.  
  181.    All other commands in the CED or PCED file are ignored by CONVERT.
  182.  
  183. CHAINCH Commands
  184. ----------------
  185.    By default, CED and PCED use the caret(^) character to separate multiple
  186. commands.  When CONVERT encounters this character in a synonym substitution
  187. string, it will replace it with the ANARKEY command-separator character,
  188. semicolon (;).
  189.  
  190.    If a CHAINCH command is encountered that changes the separator character,
  191. CONVERT will remember the new separator and replace occurrences of it with
  192. semicolons.
  193.  
  194. PARAMCH Commands
  195. ----------------
  196.    PARAMCH commands are handled in a manner similar to CHAINCH commands.
  197.  
  198.    By default, CED and PCED recognize the start of a parameter field by the
  199. percent sign (%).  Since ANARKEY uses the same character for this purpose,
  200. no conversion is normally required.
  201.  
  202.    However, the parameter-field character may be changed in CED/PCED by the
  203. PARAMCH command.  If PARAMCH changes the parameter-field character, CONVERT
  204. will remember the new character and replace all instances of it with percent
  205. signs.
  206.  
  207. SYN and USERSYN Commands
  208. ------------------------
  209.    One major difference between CED/PCED and ANARKEY is that ANARKEY does
  210. not differentiate between input requests made by the primary command
  211. processor and those made by a user program or secondary shell.  In ANARKEY,
  212. all commands are stored in the same history buffer and all AKA definitions
  213. are available at any time.
  214.  
  215.    Because of this, CONVERT treats SYN and USERSYN commands identically.  On
  216. the one hand, this saves you from having to define the same synonym twice,
  217. once for each environment.  On the other hand, it means you will have to
  218. rename any synonym names that differ only in the context of their use.  As
  219. an example, assume the following CED synonyms:
  220.  
  221.                 SYN     d       dir
  222.                 USERSYN d       dir /w
  223.  
  224.    CONVERT will translate these definitions to:
  225.  
  226.                 :d      dir
  227.                 :d      dir /w
  228.  
  229.    In this case, where two AKA definitions use the same AKA word, the second
  230. definition would replace the first when LOAD processed the file.
  231.  
  232. Other Considerations
  233. --------------------
  234.    Additional modifications besides the translation of command-separator and
  235. parameter-specification characters may occur during conversion.  For
  236. example, if the converted file is a PCED configuration file (-P), any
  237. asterisk characters (*) in the synonym name are removed.  Also, if the
  238. substitution string is bracketed by special characters (for example,
  239. quotes), they are removed.
  240.  
  241.    Note: PCALL and PCED's '*' operator are not necessary in ANARKEY.  A
  242. similar (and more powerful and elegant) functionality is provided by the
  243. character-matching history buffer retrieval method.  Refer to the "ANARKEY
  244. User Manual" for further information.
  245.  
  246.    Because the '*' operator is not necessary, many of the synonyms
  247. containing it may no longer be of any use.  For example, a synonym such as:
  248.  
  249.                 SYN     L*ONGNAME       LONGNAME
  250.  
  251. is nearly superfluous in ANARKEY.  Eliminating such definitions will reduce
  252. the amount of space ANARKEY will require for AKA storage.
  253.  
  254.    ANARKEY does not support nested AKAs and CONVERT does not look for nested
  255. synonyms in the input file.  As an example, assume the following nested
  256. synonym definitions:
  257.  
  258.                 SYN     d       dir
  259.                 SYN     dd      d^pause^d
  260.  
  261.    CED/PCED would expand the "dd" synonym to "dir^pause^dir."  CONVERT will
  262. not take the nesting action into account during translation and, thus, the
  263. resulting AKA definitions would be:
  264.  
  265.                 :d      dir
  266.                 :dd     d;pause;d
  267.  
  268.    The removal of asterisks from synonym names and ignorance of nested
  269. definitions will often result in an AKA definition that is not equivalent to
  270. its PCED original.  It is suggested that you examine the translated AKA
  271. definitions and manually perform any necessary modifications to complete the
  272. conversion.
  273.  
  274.    After CONVERT has finished its job and any touch-up is done, the file may
  275. be processed by LOAD which will pass the converted AKA definitions to
  276. ANARKEY.
  277.  
  278.    To all CED and PCED users, welcome to the world of ANARKEY!
  279.  
  280.  
  281.  
  282.                            Comments and Suggestions
  283.                            ------------------------
  284.  
  285.    I would love to hear your suggestions, comments, and enhancement ideas
  286. concerning CONVERT and the other programs in the ANARKEY software package.
  287. Please send your suggestions to:
  288.  
  289.                                 Steven Calwas
  290.                                Moderne Software
  291.                                 P.O. Box 3638
  292.                           Santa Clara, CA 95055-3638
  293.  
  294.                               _______
  295.                          ____|__     |               (tm)
  296.                       --|       |    |-------------------
  297.                         |   ____|__  |  Association of
  298.                         |  |       |_|  Shareware
  299.                         |__|   o   |    Professionals
  300.                       -----|   |   |---------------------
  301.                            |___|___|    MEMBER
  302.  
  303.